home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / gt_power / msgt135.zip / MSGT.DOC next >
Text File  |  1990-01-22  |  24KB  |  499 lines
  1. MSGT by Mark Shasby, 050/007
  2. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  3. ******  New functions / bug fixes are listed at the end of this document  ******
  4.  
  5.     The first information in here is how to set it up as a door, to find the
  6. current list of options just type MSGT. There are three ways to run the program,
  7. either as a standalone utility at the DOS prompt, under DOORWAY (by Marshall
  8. Dudley - I registered my copy, remote DOS shell is practically useless without
  9. it) or as a "normal" GT door with %1 COM%2 etc.  If you use either of the first
  10. two methods, no special parameters are required - the "door" parameter is only
  11. of use if you use %1 COM%2 in your gtdoorn/gtlogon.  The "door" parameter simply
  12. instructs MSGT to direct an extra copy to the local PC screen as well as the
  13. remote user - obviously DOORWAY does this itself.
  14.  
  15. Command line parameters
  16. ~~~~~~~~~~~~~~~~~~~~~~~
  17. gtlog     * Report host sessions from GT.LOG
  18.   nosysop     Don't include sysop in logon list
  19.   nolocal     Don't include local sessions in logon list
  20.   nolocsy     Don't include sysop in list when on local
  21.   nocrash     Don't include incoming crashes in logon list
  22.   notime      Don't display date & time in logon list
  23.   sysoploc    Use board name & loc. instead of user loc. for GT sysops
  24.   sysopnum    Use phone number instead of board loc. in above option
  25.   duration    Show call duration on gtlog report
  26.   lastn       Show last 'n' entries on gtlog report (see LastN below)
  27.   extra       Add a line of extra detail, like numbers of messages entered,
  28.               files up/downloaded.
  29.   reverse     List output in reverse order, i.e. most recent caller first.
  30.   names       Add filenames to "extra" line(s).
  31.   logtots     Print short summary report after log report,
  32.               See LogTotalsTitle below.
  33.   logonOK?    Exit with ERRORLEVEL 4 if last logon didn't get past password.
  34.   lastbit     Only reads last bit of GT.LOG when reporting - this is much faster
  35.               than a complete read but still usually includes a few days.  this
  36.               is ideal for GTLOGON reporting when you don't want to hassle the
  37.               callers' phone bills.  You obviously leave this option off when
  38.               you want a complete report.
  39.   sincelast   Report activity since last call by current logged-on user.
  40.  
  41. netlog    * Report netmail session from GTNET.LOG
  42.   nettots     Produce a summary report of the complete GTNET.LOG contents.
  43.   nodetail    Don't list the normal report, for use with nettots.
  44.  
  45. outbound  * Report on bags waiting for delivery/collection
  46.   personal    Restrict outbound report to current logged-on user
  47.  
  48. messages  * Various reports from all message areas
  49.   sysop       Check message areas for sysop instead of current user
  50.   totals      Display message counts and totals on message scan
  51.   unread      Check for unread mail on message scan
  52.   unread?     Same as above but sets ERRORLEVEL 2 if unread mail exists
  53.   entered     For GTLOGOFF.BAT only!  Scans message areas and logs any
  54.               messages entered by the last user.
  55.   since       For .BAT files only!  Similar to above but can scan for messages
  56.               entered by any offline program, see "Offline Messages" chapter
  57.               below.
  58.   msgcount    Used with "entered" or "since" if only message counts are to be
  59.               logged rather than the message area and recipient.
  60.   activity    Displays numbers of members of an area and some stats about
  61.               numbers of messages read - an extension to the "totals" function.
  62.   acticols    Columnular combination of "totals" and "activity".
  63.   excsysop    Exclude sysop from "activity" or "acticols" report.
  64.   members     List names and last read of all members of all message areas.
  65.   msgexit     Exits with errorlevel 8 if messages were entered in this
  66.               session (GTLOGOFF).  (needs "entered" to work)
  67.  
  68.  
  69. stamp     * Signals beginning of an offline message writer .BAT file, see
  70.             "Offline Messages" chapter below.
  71.  
  72. LF        * Output a blank line
  73.  
  74. pause     * Force a pause
  75.  
  76. verify    * Verify caller's phone number - see VerifyOdds below
  77.  
  78. change    * Change password for current user
  79.  
  80. door.sys  * Create a DOOR.SYS file in current directory
  81.  
  82. time      * Display the country name and time
  83.  
  84. chat      * Split-screen chat mode - will work as normal chat mode for
  85.             non-ANSI callers but is really intended for ANSI.  THIS WILL ONLY
  86.             WORK AS A "%1 COM%2" TYPE DOOR - IT WILL DEFINATELY *NOT* WORK
  87.             UNDER DOORWAY, GATEWAY ETC!  As this is only available as a
  88.             %1 COM%2 door the "door" keyword is necessary.
  89.  
  90. created   * Outputs a "report created at xxx on xxx" message for timestamping
  91.             bulletins etc.  Use with "LF" function for pretty spacing - you
  92.             could have the timestamp at the beginning or end or wherever.
  93.  
  94. * These are positional commands, for example 'MSGT gtlog pause netlog pause',
  95.   the rest can be anywhere on the line and will affect the entire line.
  96.  
  97. Parameters that apply to more than one command
  98. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  99.   ANSI?       Exit with errorlevel 1 if user can support ANSI graphics
  100.   more        Pause every 24 lines
  101.   today       Only include today's sessions
  102.   24hr        Only include sessions within last 24 hours
  103.   door        MSGT running as a basic "%1 COM%2" type door (recommended)
  104.   noANSI      Force output to non-ANSI, for piping to bulletins etc.
  105.   nopause     Disable ALL pauses - useful for piping to bulletins etc.
  106.   why?        Instead of timer during working, display the reason for the
  107.               working.  Intended for debugging only as the average caller
  108.               won't want to know what file is being read etc.
  109.   noIBM       Don't use IBM PC only character set.
  110.   nowork      Don't display timer thingy, even while working - useful for
  111.               piping reports to files.
  112.  
  113. "Permanent" options within MSGT.CNF in your GTPATH
  114. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  115.   BoardName = 'Shasby's Lair'
  116.  
  117.     Name of your BBS for MSGT reports.
  118.  
  119.   Country = 'Bulgaria'
  120.  
  121.     Name of country you're in for the "time" command line option.
  122.  
  123.   WorkingStates = '|/-\'
  124.  
  125.     String of characters to spin as timer thingy while working or waiting for
  126.     a pause.
  127.  
  128.   WorkingColour = 'rgby'
  129.  
  130.     String of colours for above characters, the letters for various colours can
  131.     be found by typing "msgt".
  132.  
  133.   Postman = 'Postman Pat'
  134.  
  135.     String to show on GTLOG report for incoming crash call.
  136.  
  137.   USdate = True | False
  138.  
  139.     Use US-format date & time in reports.
  140.  
  141.   Pause = 'Enter' | 'Space' | 'Random'
  142.  
  143.     Use random letters, ENTER or SPACE to terminate pauses.
  144.  
  145.   PauseWait = 0
  146.  
  147.     If this number is non-zero a limit (number of seconds) is put on a pause
  148.     wait.  The pause message states the wait time.
  149.  
  150.   PauseTimer = True | False
  151.  
  152.     Display timer thingy while paused.
  153.  
  154.   MailDrive = 'D'
  155.  
  156.     Set to drive letter of disk with \MAILOUT etc., leave as '' and will use
  157.     current logged drive.
  158.  
  159.   EchoString = 'echo'
  160.  
  161.     Exclude visiting sysops from scan of areas whose descriptions include this
  162.     string, default "echo".
  163.  
  164.   LastN = 10
  165.  
  166.     Number of entries for 'n' in 'lastn' option.
  167.  
  168.   MinPasswordLen = 5
  169.  
  170.     Minimum length of password entered in 'change' command.
  171.  
  172.   VerifyOdds = 10
  173.  
  174.     One in something chance of caller being verified, i.e. in the example the
  175.     callers will be asked to verify their phone number on average every tenth
  176.     call.
  177.  
  178.   VerifyTries = 3
  179.  
  180.     Maximum number of attempts at verification, if your callers are pretty
  181.     thick you may want to let them have more tries.  If you are exceptionally
  182.     security conscious and want to ensure that people use their real phone
  183.     numbers, 2 tries would be plenty - providing the line noise isn't too bad.
  184.  
  185.   DegradeLevel = 'V'
  186.  
  187.     Class to degrade callers to who can't verify - if this is '' they will be
  188.     warned but not degraded.  The sysop will still get the message and can
  189.     investigate if required.
  190.  
  191.   NonSysop = 'Mark Shasby'
  192.  
  193.     Name of caller to exclude from sysoploc scan, this was added because in the
  194.     area where the MSGT beta testers live there are a few people with the same
  195.     names as US sysops in the nodelist.  These callers from Accrington,
  196.     Lancashire, UK didn't want to be shown as sysop of XXXX from Washington DC
  197.     so this facility was added.  It should not cause any problems because there
  198.     can only be one person registered on your system with such a name anyway,
  199.     and they will either be the sysop or not.
  200.  
  201.   Define GTLOGON = 'gtlog today sysoploc sysopnum duration'
  202.  
  203.     This defines "groups" of command line parameters so that your .BAT files
  204.     aren't ridiculously large, the "GTLOGON" or whatever can be any word
  205.     including the parameters I have defined so you can change the meaning of
  206.     those of you want.  There can be any number of "Define"s, but remember that
  207.     the words you define are case-sensitive!  Defines can be nested to any depth
  208.     you may fancy but the resultant "command line" is limited to 255 chars.
  209.  
  210.   Stamp MMR = 'Sysop, using MMR entered'
  211.  
  212.     This defines a "stamp" and relates a description to appear on the "gtlog"
  213.     report.  There must be a description even if you choose not to display it
  214.     in the "gtlog" report as this line is necessary to define a stamp to MSGT.
  215.     If you are not using an offline message writer you don't need any "Stamp"
  216.     entries.
  217.  
  218.   TimeStamp = 12345678
  219.   LastScan = 12345678
  220.  
  221.     These are internal variables only of interest to MSGT.  If you want further
  222.     info you are welcome to it but it is beyond the scope of this document.
  223.  
  224.   LogTotalsTitle = 'Summary of activity this month'
  225.  
  226.     Used as the title for the "gtlog logtots" report.  Your GT.LOG may be kept
  227.     for one week, one month, whatever you feel like - this gives you the option
  228.     to title the report accordingly.
  229.  
  230.   LogBodge = '***'
  231.  
  232.     This allows you to define a word that signifies a non-standard entry in
  233.     GT.LOG.  Some programs from OZ stamp things in the log with the above
  234.     prefix.  They should really be using the GT comment syntax like MSGT does
  235.     though to avoid problems with other log-reading utilities.
  236.  
  237.   MinPhoneLen = 9
  238.  
  239.     You can set the minimum length of the phone numbers accepted by the
  240.     "verify" function.  This could be 1 if you don't want any hassle on that
  241.     front?
  242.  
  243.   PhoneText = 'you must enter your full national phone number'
  244.  
  245.     This text is typed before every request for a phone number by "verify".
  246.     It allows a sysop to enter country-specific information about what you
  247.     accept but please remember that a lot of people call from other countries!
  248.  
  249. Offline Messages
  250. ~~~~~~~~~~~~~~~~
  251.     If you are using the "gtlog extra" facility to display message counts or
  252. some other utility using the "MSGT Msg" or "MSGT MsgCount" entries, you may
  253. want to include messages entered "offline" with MMR (by Harry Green), BMM (by
  254. Stephen De Plater) or other utilities (Sorry for not mentioning the others, I
  255. haven't heard of them yet!).  The "stamp" option in conjunction with the
  256. "messages since XXXX" (where XXXX is defined in MSGT with a "Stamp" line) can
  257. be used for this purpose.  You will first need to define a "Stamp" in MSGT.CNF,
  258. the example above is for MMR but will work for any offline message writer.
  259. Note the strange wording of the description, that is not important now but will
  260. become clear as reports are written to use the data.  You then need to create a
  261. .BAT file to run your message creating utility.  I will use MMR in the example
  262. but the name of the utility is unimportant.  Here is an example CALLMMR.BAT to
  263. demonstrate the system...
  264.  
  265.     @echo off
  266.     msgt stamp
  267.     MMR               /* or whatever */
  268.     msgt messages since MMR
  269.  
  270. ...Notice that the MMR mentioned in line 3 is the utility being called to enter
  271. messages but the MMR mentioned in the bottom line is the "Stamp" defined in
  272. MSGT.CNF.
  273.  
  274.     Note you can have as many different "Stamp"s as you want, you may have one,
  275. for example, to log messages entered by a utility that automatically upgraded
  276. good uploaders or something?
  277.  
  278. Memory requirements
  279. ~~~~~~~~~~~~~~~~~~~
  280.     All the data structures in this program are variable sized so that memory
  281. usage is as efficient as possible.  The one complaint received to date about
  282. memory was from a sysop with a 512K machine running GT 15.01 and just over 500
  283. users - he had to use /V:L on the GT command line to cause the GTLOGON.BAT to
  284. run in overlay mode.  The same would probably apply to MSGT in a door on a
  285. similar sized machine & user file in which case /V:D would be required (if both
  286. are required then /V:DL is the format).
  287.  
  288. The wobblegob at the end
  289. ~~~~~~~~~~~~~~~~~~~~~~~~
  290. Suggestions, complaints to 050/007 via netmail or feel free to call and page
  291. between 0700-1530 GMT weekdays for help or a chat about the weather.
  292.  
  293. Any GT utility writers in the world who like/use any of my programs can show
  294. their appreciation by donating a registered copy of your utilities!  :-)
  295.  
  296. Anyone else who has too much money can of course send some to me and I won't
  297. argue whatsoever - the address is...
  298.  
  299.     Mark Shasby,
  300.      c/o Immoral Earnings Dept.,
  301.       33 Park Road,
  302.        Waterfoot,
  303.         Rossendale,
  304.          Lancashire.
  305.           BB4 9BW
  306.        United Kingdom
  307.  
  308. New functions / bug fixes
  309. ~~~~~~~~~~~~~~~~~~~~~~~~~
  310. This section was started on the 8th November with release 79.
  311.  
  312. November  8th 1989 - 09:54 - MSGT79:  Help removed from .EXE, bug with *X and =X
  313.                                       in GTMDIR fixed, "Define" function in
  314.                                       MSGT.CNF completed.
  315.  
  316. November  9th 1989 - 09:21 - MSGT84:  "extra" option added to "gtlog" report,
  317.                                       "messages entered" option added, "Carrier
  318.                                       Loss" flag added to "gtlog" report.
  319.                                       "gtlog" report is getting extremely messy,
  320.                                       any suggestions as to a suitable layout
  321.                                       would really be appreciated!
  322.  
  323. November  9th 1989 - 10:42 - MSGT86:  "why?" option added to aid debugging.
  324.  
  325. November  9th 1989 - 13:52 - MSGT88:  Fixed bug in "gtlog extra" option, was
  326.                                       including files after DISCONNECT for
  327.                                       previous user.
  328.  
  329. November 10th 1989 - 08:18 - MSGT89:  Added message number to "messages unread"
  330.                                       report.
  331.  
  332. November 10th 1989 - 11:18 - MSGT93:  Replaced "RandomPause" option (MSGT.CNF)
  333.                                       with "Pause" option, adding SPACE to list
  334.                                       of choices.  "PauseWait" also added to
  335.                                       MSGT.CNF allowing maximum wait time on a
  336.                                       pause if required.
  337.  
  338. November 10th 1989 - 12:33 - MSGT94:  "time" command line option added together
  339.                                       with corresponding "Country" variable in
  340.                                       MSGT.CNF.
  341.  
  342. November 10th 1989 - 15:15 - MSGT95:  "Memory requirements" section added to
  343.                                       documentation.  First compilation under
  344.                                       TP 5.5 Professional, please report weird
  345.                                       happenings.
  346.  
  347. November 13th 1989 - 07:38 - MSGT96:  Fixed bug where "gtlog extra" didn't spot
  348.                                       BiModem transfers.  "Opened N doors" now
  349.                                       added to "gtlog extra" report.  Added
  350.                                       "nolocsy" option to "gtlog" report to
  351.                                       exclude sysop only when local.
  352.  
  353. November 13th 1989 - 09:55 - MSGT97:  Added pending .FRs to "outbound" report.
  354.  
  355. November 13th 1989 - 13:44 - MSGT98:  Time for "messages entered" processing
  356.                                       decreased vastly.
  357.  
  358. November 14th 1989 - 07:54 - MSGT99:  Bugs fixed in "messages entered" related
  359.                                       to GT.LOG format and messages with future
  360.                                       dates - entered on system with sysop who
  361.                                       can't set dates properly!
  362.  
  363. November 14th 1989 - 08:22 - MSGT100:  Coloured in the "gtlog extra" lines and
  364.                                        added "reverse" option to "gtlog".
  365.  
  366. November 14th 1989 - 14:31 - MSGT101:  Added "names" option to "gtlog extra".
  367.  
  368. November 15th 1989 - 07:11 - MSGT102:  Fixed bug relating to "gtlog extra
  369.                                        names" and BiModem (isn't it always?).
  370.                                        Fixed bug in reading NODELIST.BBS, now
  371.                                        aware of point notation.
  372.  
  373. November 16th 1989 - 12:51 - MSGT103:  "messages entered" was reading more
  374.                                        files than necessary - not any more!
  375.  
  376. November 17th 1989 - 11:42 - MSGT104:  "stamp", "messages since" feature added,
  377.                                        mainly of use to MMR/BMM users to keep
  378.                                        logs of messages entered offline.
  379.                                        "msgcount" option added to "messages
  380.                                        entered" and "messages since".
  381.  
  382. November 17th 1989 - 12:44 - MSGT105:  "outbound" now reports any pending .DX
  383.  
  384. November 20th 1989 - 09:37 - MSGT106:  "Scan cancelled" message not appearing
  385.                                        at random any more. "24hr" option added
  386.                                        (affects "gtlog" and "netlog").
  387.  
  388. November 21st 1989 - 11:13 - MSGT107:  Incoming crashes disappeared from all
  389.                                        reports in 106 - back now.
  390.  
  391. November 21st 1989 - 13:01 - MSGT108:  "gtlog logtots" option added and
  392.                                        corresponding MSGT.CNF entry.
  393.  
  394. November 22nd 1989 - 09:34 - MSGT109:  "unread?" option added to "messages"
  395.                                        function.
  396.  
  397. November 22nd 1989 - 14:38 - MSGT110:  Fixed "logtots" problem with counting
  398.                                        days in GT.LOG.  Fixed "gtlog today"
  399.                                        problem - was showing last call of
  400.                                        previous day.  Fixed "nocrash" option,
  401.                                        crashes were showing regardless.  First
  402.                                        attempt at shared access is in this
  403.                                        release.  "logonOK?" option added to
  404.                                        "gtlog".
  405.  
  406. November 23rd 1989 - 15:30 - MSGT111:  Fixed problem with remote input not
  407.                                        echoing to local screen properly.  Fixed
  408.                                        problem with "gtlog extra" not reporting
  409.                                        everything.
  410.  
  411. November 24th 1989 - 08:07 - MSGT112:  Runtime error 5 on "verify" fixed.
  412.  
  413. November 28th 1989 - 09:14 - MSGT113:  A few extra lines added to "gtlog
  414.                                        logtots".
  415.  
  416. November 28th 1989 - 14:41 - MSGT114:  "lastbit" function added to "gtlog",
  417.                                        speeds up report vastly for GTLOGON use.
  418.  
  419. November 29th 1989 - 08:07 - MSGT115:  "lastbit" speeded up a little bit more.
  420.  
  421. November 30th 1989 - 14:13 - MSGT116:  "nettots" and "nodetail" options added
  422.                                        to "netlog".  "noIBM" and "nowork" added
  423.                                        to all options.
  424.  
  425. November 30th 1989 - 15:00 - MSGT117:  "verify" option fixed - it appeared to
  426.                                        be ignoring " " and "-" (wasn't really).
  427.  
  428. December  1st 1989 - 14:01 - MSGT118:  "nettots" output prettied up a bit and
  429.                                        baud rate columns added.  "verify" now
  430.                                        reports failed numbers to sysop.
  431.  
  432. December  4th 1989 - 12:46 - MSGT119:  Breakdown of connect speeds added to
  433.                                        "logtots" report.
  434.  
  435. December  5th 1989 - 11:34 - MSGT120:  "activity" and "excsysop" added to
  436.                                        "messages" report.
  437.  
  438. December  7th 1989 - 09:31 - MSGT121:  "acticols" and "members" options added
  439.                                        to "messages" report.
  440.  
  441. December 10th 1989 - 16:12 - MSGT122:  "gtlog" now reports "stamp"ed entries.
  442.  
  443. December 11th 1989 - 15:19 - MSGT123:  "LogBodge" option added to MSGT.CNF,
  444.                                        "sincelast" option added to "gtlog".
  445.  
  446. December 13th 1989 - 09:30 - MSGT124:  Initial code for "chat" function added,
  447.                                        read the description above before use,
  448.                                        ideas for pretty bits very welcome!
  449.  
  450. December 14th 1989 - 09:09 - MSGT126:  OK, so I forgot to add this on the 125
  451.                                        release - it was just a change to the
  452.                                        "chat" screen anyway.  This release is
  453.                                        to "netlog nettots" to make sub-1Kbyte
  454.                                        transfers show as 1K.
  455.  
  456. December 19th 1989 - 15:15 - MSGT127:  "MinPhoneLen" and "PhoneText" lines
  457.                                        added to MSGT.CNF - used with "verify"
  458.                                        function - HEAVY DEMAND FOR THIS!
  459.  
  460. December 27th 1989 - 09:52 - MSGT128:  "msgexit" added.
  461.  
  462. January   4th 1990 - 14:04 - MSGT129:  "created" function added.  While I'm
  463.                                        here I'd like to mention that if a
  464.                                        caller selects no ANSI and the GTLOGON
  465.                                        / GTDOOR is using the %1 COM%2 method,
  466.                                        only monochrome is sent to their screen,
  467.                                        although colour still displays on the
  468.                                        local console - there is no need to call
  469.                                        MSGT with the "ANSI?" parameter etc.
  470.  
  471. January   8th 1990 - 16:05 - MSGT130:  Added support for a few more control
  472.                                        characters in GT message/file area
  473.                                        descriptions (&, % etc.).
  474.  
  475. January   9th 1990 - 18:04 - MSGT131:  Fixed bug causing incorrect durations
  476.                                        in "gtlog duration" and fixed "24hr"
  477.                                        not selecting proper times in "gtlog"
  478.                                        and "netlog".
  479.  
  480. January  11st 1990 - 09:24 - MSGT132:  OK, OK, so I'm a plonker - I guess you
  481.                                        all saw the "January 11st" date from the
  482.                                        "time" function then?
  483.  
  484. January  19th 1990 - 10:52 - MSGT133:  More statistics reported from "gtlog
  485.                                        logtots" function.
  486.  
  487. January  19th 1990 - 17:53 - MSGT134:  Some features still in development were
  488.                                        taking too much storage in 133 and
  489.                                        causing runtime error 3, I have removed
  490.                                        them and will have to re-design the
  491.                                        algorithms!
  492.  
  493. January  22nd 1990 - 11:36 - MSGT135:  "netlog" was hanging system if it found
  494.                                        an entry in GTNET.LOG from a node that
  495.                                        wasn't in the NODELIST.  Fixed bug and
  496.                                        now displays a message about it - very
  497.                                        sorry to any systems I hung in netmail,
  498.                                        especially intercontinental hubs!
  499.